// --------------------------------------------------------------------------------------------------------------------
// <copyright file="StrategyEventArgs.cs" company="Open Trader">
//   Copyright (c) David Denis (david.denis@systemathics.com)
// </copyright>
// <summary>
//   |  Open Trader - The Open Source Systematic Trading Platform
//   |
//   |  This program is free software: you can redistribute it and/or modify
//   |  it under the terms of the GNU General Public License as published by
//   |  the Free Software Foundation, either version 2 of the License, or
//   |  (at your option) any later version.
//   |
//   |  This program is distributed in the hope that it will be useful,
//   |  but WITHOUT ANY WARRANTY; without even the implied warranty of
//   |  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//   |  GNU General Public License for more details.
//   |
//   |  You should have received a copy of the GNU General Public License
//   |  along with this program.  If not, see http://www.gnu.org/licenses
//   |
//   |  Up to date informations about Open Trader can be found at :
//   |    http://opentrader.org
//   |    http://opentrader.codeplex.com
//   |
//   |  For professional services, please visit us at :
//   |    http://www.systemathics.com
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace Org.OpenTrader.Framework.Forge.Events
{
    #region Using Directives

    using System;

    using Org.OpenTrader.Framework.Events;
    using Org.OpenTrader.Framework.Forge.Interfaces;

    #endregion

    /// <summary>
    /// The strategy event args.
    /// </summary>
    [Serializable]
    public abstract class StrategyEventArgs : AbstractEventArgs
    {
        /// <summary>
        /// The strategy state changed event args.
        /// </summary>
        public class StateChanged : StrategyEventArgs
        {
            #region Constructors and Destructors

            /// <summary>
            /// Initializes a new instance of the <see cref="StateChanged"/> class. 
            /// Initializes a new instance of the <see cref="StrategyStateChangedEventArgs"/> class.
            /// </summary>
            /// <param name="oldState">
            /// The oldState.
            /// </param>
            /// <param name="state">
            /// The state.
            /// </param>
            public StateChanged(EStrategyState oldState, EStrategyState state)
            {
                this.PreviousState = oldState;
                this.State = state;
            }

            #endregion

            #region Properties

            /// <summary>
            /// Gets PreviousState.
            /// </summary>
            public EStrategyState PreviousState { get; private set; }

            /// <summary>
            /// Gets State.
            /// </summary>
            public EStrategyState State { get; private set; }

            #endregion

            #region Public Methods

            /// <summary>
            /// The to string.
            /// </summary>
            /// <returns>
            /// The to string.
            /// </returns>
            public override string ToString()
            {
                return string.Format("StateChanged[PreviousState={0};State={1}]", this.PreviousState, this.State);
            }

            #endregion
        }
    }
}